Application, Group and Entity Discovery

Use the following URL to retrieve the applications, groups or entities (not the actual performance monitoring parameter). The following attributes are specified for the last interval:

■

id – node ID

■

description – short textual description

On application discovery, groups are also returned per application.

URL

■

Application:

/api/v1/kpi/current
/api/v1/kpi/history

■

Group:

/api/v1/kpi/current/<app>
/api/v1/kpi/history/<app>

■

Entity:

/api/v1/kpi/current/<app>/<group>
/api/v1/kpi/history/<app>/<group>

HTTP Method

GET

Supported Parameters

Parameter	Type	Description
?before=<Name>	String	Returns the applications, groups or entities that are listed before the specified application, group or entity.
?after=<Name>	String	Returns the applications, groups or entities that are listed after the specified application, group or entity. For example, to return a list of all applications listed after the sbc application: /api/v1/kpi/current?after=sbc
?limit=<Count>	Number	Returns the first number (count) of listed applications, groups or entities. For example, to request the first 3, the Get must be set to "?limit=3".
?kpi=<Name>	String	Returns the description and value of a specified performance monitoring parameter (located in the requested path). For example: /api/v1/kpi/current/sbc/callStats/global?kpi=busyCallsInTotal
?detailed=true|false	String	When it equals false (default is enabled) some fields are not returned in the response (e.g., name and description).
<Cursor Information>	String	Returns next (after) or previous (before) results (see Cursor-based Pagination for more information).

HTTP Responses

■

200 OK

■

204 No Content – nothing to discover

■

400 Bad Request – bad query parameter or invalid path

Example 1

■

Request:

GET /api/v1/kpi/current HTTP/1.1
Host: 10.4.219.229 

■

Response:

 HTTP/1.1 200 OK
Content-Type: application/json
{
    "items": [
        {
            "id":"sbc",
            "description": "SBC application statistics",
            "url": "/api/v1/kpi/current/sbc",
            "groups": [
                "callStats",
                "otherStats"
                "sipRecStats"
        },
        {
            "id": "media",
            "description": "Media application statistics",
            "url": "/api/v1/kpi/current/media",
            "groups": [
                "clusterStats",
                "coderStats"
                "dspStats",
                "mediaStats"
        },
        …
     ]
}

Example 2

■

Request:

GET /api/v1/kpi/current/sbc HTTP/1.1
Host: 10.4.219.229 

■

Response:

 HTTP/1.1 200 OK
Content-Type: application/json
{
    "items": [
        {
            "id": "callStats",
            "description": "Call statistics",
            "url": "/api/v1/kpi/current/sbc/callStats"
        },
        {
            "id": "otherStats",
            "description": "Other Dialogs statistics",
            "url": "/api/v1/kpi/current/sbc/otherStats"
        },
        …
     ]
}

Example 3

■

Request:

GET /api/v1/kpi/current/sbc/callstats HTTP/1.1
Host: 10.4.219.229 

■

Response:

 HTTP/1.1 200 OK
Content-Type: application/json
{
    "items": [
        {
            "id": "global",
            "description": "Global call statistics",
            "url": "/api/v1/kpi/current/sbc/callStats/global"
        },
        {
            "id": "ipGroup",
            "description": "Per-IPGroup statistics",
            "url": "/api/v1/kpi/current/sbc/callstats/ipGroup"
        },
     …
     ]
}